This section provides the meaning of the attributes included in the API.
🔑 API KEYS
- "Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 36 characters, maximum 37 characters
- Description: Authentication token required to access the API.
- "client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.
- Type: String
- Length: Minimum 32 characters, maximum 36 characters
- Description: Unique client identifier to authenticate the request.
NOTE: It is important to have these API KEYS to make any request to our services.
✨ Core Policy Issuance (POST /Services/v1/CorePolicyIssuance)
- "policyNumber"
- Type: String
- Length: Max 20 characters
- RegEx:
[A-Za-z0-9-]
- Description: Unique identifier for the policy being issued.
- "insuredName"
- Type: String
- Length: Max 100 characters
- RegEx:
[A-Za-z0-9 ]
- Description: Full name of the insured individual or entity.
- "effectiveDate"
- Type: String (Date Format:
YYYY-MM-DD
) - Description: Start date of the policy coverage.
- "expiryDate"
- Type: String (Date Format:
YYYY-MM-DD
) - Description: End date of the policy coverage.
- "premiumAmount"
- Type: Number (Decimal)
- Description: Total premium amount to be paid for the policy.
- "currency"
- Type: String
- Length: 3 characters
- RegEx:
[A-Z]{3}
- Description: Currency code in ISO 4217 format (e.g., USD, EUR).
📊 Common Parameters
Parameter | Type | Description | Required |
---|
client_id | string | Unique identifier for API clients | ✅ |
Authorization | string | Bearer token for secure access | ✅ |
policyNumber | string | Policy identifier | ✅ |
insuredName | string | Name of the insured | ✅ |
effectiveDate | string | Policy start date | ✅ |
expiryDate | string | Policy end date | ✅ |
premiumAmount | number | Total premium amount | ✅ |
currency | string | Currency code | ✅ |
🔒 Security Schemes
Client ID Enforcement
Field | Type | Required | Length (characters) | RegEx |
---|
client_id | String | Yes | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Yes | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
Field | Type | Required | Length (characters) | RegEx |
---|
Authorization | String | Yes | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Common Error Codes
Code | Description | Suggested Solution |
---|
400 | Bad Request | Verify the request structure. |
401 | Unauthorized | Check the authentication credentials. |
404 | Not Found | Ensure the endpoint is correct. |
500 | Internal Server Error | Try again later or contact support. |
📞 Support
For any questions or issues, please contact the API support team INTEGRATION SERVICES AND APPLICATIONS COORDINATION.
Notes
- Documentation adjusted in February 2025.
- For additional information, contact: epalma@fgs.co